Skip to content

Add api-contract-audit skill for type hint checking - #962

Open
Rimsha2535 wants to merge 16 commits into
mainfrom
feature/942-add-api-contract-audit-skill
Open

Add api-contract-audit skill for type hint checking#962
Rimsha2535 wants to merge 16 commits into
mainfrom
feature/942-add-api-contract-audit-skill

Conversation

@Rimsha2535

@Rimsha2535 Rimsha2535 commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Fixes #942

Summary

Added the api-contract-audit skill to help identify mismatches between type annotations, docstrings and runtime behavior in Python libraries. The skill was verified against PyExasol and works as expected.

Checklist

Note: If any of the items in the checklist are not relevant to your PR, just check the box.

For any Pull Request

Is the following correct:

  • the title of the Pull Request?
  • the title of the corresponding issue?
  • there are no other open Pull Requests for the same update/change?
  • that the issue which this Pull Request fixes ("Fixes...") is mentioned?

When Changes Were Made

Did you:

  • update the changelog?
  • update the cookiecutter-template?
  • update the implementation?
  • check coverage and add tests: unit tests and, if relevant, integration tests?
  • update the User Guide & other documentation?
  • resolve any failing CI criteria (incl. Sonar quality gate)?

When Preparing a Release

Have you:

  • thought about version number (major, minor, patch)?
  • checked Exasol packages for updates and resolved open vulnerabilities, if easily possible?

ArBridgeman
ArBridgeman reviewed Sep 22, 2026
View reviewed changes
Comment thread doc/changes/unreleased.md Outdated
jana-selva
jana-selva requested changes Sep 22, 2026
View reviewed changes
Comment thread exasol/toolbox/skills/api-contract-audit/SKILL.md
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml
ArBridgeman
ArBridgeman reviewed Sep 24, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 24, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 24, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
@jana-selva jana-selva mentioned this pull request Sep 24, 2026
Merged
@Rimsha2535 @ArBridgeman
Update test/resources/skills/api-contract-audit/eval_cases.yml
c4b6684 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Update test/resources/skills/api-contract-audit/eval_cases.yml
14b2061 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Update test/resources/skills/api-contract-audit/eval_cases.yml
873dd36 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@jana-selva
Refine API contract audit evaluation cases (#964)
097f8c2 
* Improve API contract skill evaluation cases

* Explain evaluation case expectations

* Keep API audit evaluation library agnostic
ArBridgeman
ArBridgeman reviewed Sep 25, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 25, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 25, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 25, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 25, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
ArBridgeman
ArBridgeman reviewed Sep 25, 2026
View reviewed changes
Comment thread test/resources/skills/api-contract-audit/eval_cases.yml Outdated
@sonarqubecloud

sonarqubecloud Bot commented Sep 25, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@Rimsha2535 @ArBridgeman
Apply suggestion from @ArBridgeman
544ab26 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Apply suggestion from @ArBridgeman
569a160 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Apply suggestion from @ArBridgeman
47a240b 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Apply suggestion from @ArBridgeman
b39bf03 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Apply suggestion from @ArBridgeman
77fee80 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>
@Rimsha2535 @ArBridgeman
Apply suggestion from @ArBridgeman
04de7a5 
Co-authored-by: Ariel Schulz <43442541+ArBridgeman@users.noreply.github.com>

This branch is waiting to be deployed

1 waiting deployment
manual-approval — 04de7a5f Waiting Sep 25, 2026 by Rimsha2535 via Merge Gate / Extension / Approve Running Slow Tests? #2831
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ArBridgeman ArBridgeman ArBridgeman left review comments
@jana-selva jana-selva Awaiting requested review from jana-selva

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add skill for projects to check their typings

3 participants

@Rimsha2535 @ArBridgeman @jana-selva